Skip to main content
POST
Close ledger period

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
through_month
string
required

Last month to close, formatted YYYY-MM: an ended month after the last closed month. Every earlier month is closed too.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
Example:

"2026-09"

reason
string

Why the months are closed, 1 to 500 characters.

Required string length: 1 - 500

Response

ledger_id
string
required

Ledger identifier.

closed_through_date
string<date> | null
required

Last day of the last closed month (UTC), formatted YYYY-MM-DD. Null when no month is closed.

Example:

"2026-09-30"

closed_through_month
string | null
required

Last closed month, formatted YYYY-MM. Null when no month is closed.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
Example:

"2026-09"

latest_closable_month
string
required

Latest month that can be closed: the month before the current UTC month, formatted YYYY-MM.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
Example:

"2026-09"